.TH clreqd 1 "1 November 2008" "TrueCL Commands"

.SH NAME
clreqd \- TrueCL Cluster Request Daemon

.SH SYNOPSES
.TS
l l.
clreq	[\fB--debug\fP|\fB--verbose\fP|\fB--quiet\fP|\fB--silent\fP] [\fB--width\fP=\fIN\fP]
	[\fB--nodetach\fP]
.TE

.SH DESCRIPTION
The \fIclreqd(1)\fP daemon is a critical component of the TrueCL cluster
architecture. All nodes are expected to run this daemon, even when they are not
currently participating in the functioning of the cluster [for whatever reason].

It is recommended that this daemon is started automatically when any machine
in the cluster boots. Indeed, it is recommended that this daemon is managed by 'init'
or the tool that performs 'init'-type functionality for your platform/distribution.

.SH ARGUMENTS
.TP 8
--debug
When this argument is specified the utility produces significant amounts
of debug output to the log file it keeps. Typically this is only used 
when problems occur; in more operational conditions the logs it 
generaters are too large for a moderately active cluster.
.TP
--verbose
This is the standard level of logging; it generates enough detail for
system administrators to diagnose standard cluster problems.
.TP
--quiet
When this option is set only warning and error messages are written 
to the log file generated by the \fIclreqd(1)\fP daemon.
.TP
--silent
Do not generate any output apart from critical errors.
.TP
--lwidth
Indicates the width of lines to generate in the log file being word-wrapping.
If this is not specified the utility will attempt to determine the width of
the current terminal and use that. If not possible it will default to 80.
.TP
--nodetach
By default this program runs as a daemon in the background detached from
any current terminal session. This argument can be used to run it in the
foreground. This is mainly used for running the utility via \fIinit(1)\fP
or equivalent.

.SH OUTPUT
Since this utility is meant to be run as a daemon it does not generate any
output to the standard output or standard error devices. Instead output to
this descriptors are sent to log files [see the \fBFILES\fP section below
for more details].

.SH EXIT CODES
In normal operation this utility does not return - but runs until
restarted or requested to terminate. Also since it runs as a detached
process it is difficult to retrieve the exit code anyway/

.SH FILES
The daemon makes use of the following files:

.TS
l l.
clreqd.log	The destination for all daemon output/errors.
clreqd.stdout	Any standard output by the deamon or requests.
clreqd.stderr	Any standard error sent by daemon or requests.
.TE

All the files are written to the directory \fBTRUECL_LOG\fP, as
defined in the environment.

.SH NOTES
This daemon is critical to operation of the node - it should always be
running. It can be restarted using the \fIclreq(1)\fP utility and this
action is typically performed when the cluster software is upgraded
whilst the cluster is running.

.SH AUTHOR
The TrueCL software was written by Simon Edwards, (C) 2006-2008, working
for Advantsys Computer Services Ltd - www.advantsys.co.uk.

.SH SEE ALSO
.BR clreqd(1),
.BR clreqd_cmds(1)

.SH AVAILABILITY
This utility was specifically written under the GNU GPL license and as required
by such software comes with \fIno warranty or guarantee of any kind\fP. For
more information, please see the following page: truecl.advantsys.co.uk.

